Search Capabilities
The Service Request Microservice provides a set of APIs that allows the consumers to retrieve or search Service Request details and the Configuration details based on specific predefined criteria(s).
Retrieve API & Search APIs are the retrieved APIs or the service requests and configurations. The response details and the response time for these APIs vary from one category to another.
Retrieve API
A Retrieve API should narrow to a unique party or minimize the set of Service Request details or the Configuration details.
API name: GetAllRequestDetailsByRequestId
Query Options
Retrieve Criteria | Query Parameters | Operator |
|---|---|---|
Service Request ID | requestID from base URL | Equals |
Rules
- It is mandatory to supply the Service Request ID.
Search API
A search API could potentially narrow down to an extensive set of Service Request details and Configuration details, depending on the criteria and the distribution of various Service Request details and Configuration data ( e.g., common Type, SubType, Page number, Page size, etc.)
API name: GetServiceReqConfig
Query Options
Search Criteria | Query Parameters | Operator |
|---|---|---|
Type | Type | Equals |
SubType | Equals | |
Type&SubType | Equals |
Rules
- The search criteria include Type, SubType or both.
- It lists all the Service Requests details if the Type and SubType are not considered.
API name: getServiceRequestBasedOnCriteria
Query Options
Search Criteria | Query Parameters | Operator |
|---|---|---|
| Party ID | partyId | Equals |
| Page | pageSize | Equals |
| pageNumber | Equals | |
| Status | status | Equals |
| Account ID | accountId | Equals |
Date
| dateFrom | Equals |
| dateTo | Equals | |
| Type | type | Equals |
| Sub Type | subType | In |
| Reference Name from middle office | bankReferenceName | Equals |
| Stage of Service Request in middle office | requestStage | In |
| Internal Status | requestStatus | Equals |
- The Party ID is mandatory. It can also be comma-separated values.
- The search criteria can be performed based on pageSize or pageNumber.
- The Service Request and the Account ID status are the search criteria.
- All Service Requests are listed for an account ID starting from the given date. An ending Date is optional.
- If no parameter is specified, all the service request configurations are listed.
API name: GetSRAttributeHistory
Query Options
Search Criteria | Query Parameters | Operator |
|---|---|---|
| Request ID | requestId | Equals |
- GetSRAttribute History is used to get the Service Requests for a Request ID.
- If there are no query criteria, the entire History is listed.
API name: GetRequestDetails
The GetRequestDetails API is used to fetch Service Request details based of partyID.
Query Options
Search Criteria | Query Parameters | Operator |
|---|---|---|
| Page | pageSize | Equals |
| pageNumber | Equals | |
| Service Request Status | status | Equals |
| Account ID | accountId | Equals |
Date
| dateFrom | Equals |
| dateTo | Equals | |
| Type | type | Equals |
| Sub Type | subType | Equals |
- GetRequestDetails gives all the service requests available.
- There are no query criteria, and this search request returns all the service requests that are present along with their details.
API name: getSRAuditHistoryV2
The getSRAuditHistoryV2 API is used to fetch the details of the actions performed on a service request. The following query parametersis used for filter records
Query Options
Search Criteria | Query Parameters | Operator |
|---|---|---|
| Action Type | actionType | Equals |
| Action Owner ID | actionOwnerID | Equals |
For more information on Payload API details, refer to Swagger documentation.
In this topic